[kbn-eslint-plugin-eslint] add scout_api_test_discourage_kbn_client rule #245178
+281
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new ESLint rule to discourage the use of the
kbnClientfixture within API tests in Scout. The rule emits a warning ifkbnClientis unpacked or used directly in the test body, guiding test authors to avoid using it for endpoint validation and to follow best practices.Why
kbnClientin API tests, which can lead to privilege issues or unclear test intent.apiClientfor endpoint validation, maintaining consistency and clarity in test design.What changed
kbnClientin API test blocks.kbnClientis used, but can be overridden with a comment in rare, justified cases.How to use
kbnClientin the test body.